<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html lang="en">
<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Fri, 23 Jul 2010 20:16:22 +0000">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">

<title>HR_apiExceptions.php (Hosting Reborn API PHP Library)</title>

</head>
<body id="file" onload="parent.document.title=document.title;">

<div class="header">
<h1>Hosting Reborn API PHP Library</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li>Package</li><li>Class</li><li>Tree</li><li><a href="../overview-files.html">Files</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../index.html" target="_top">Frames</a>
<a href="../source/hr_apiexceptions.php.html" target="_top">No frames</a>
</div>
<hr>

<h1>HR_apiExceptions.php</h1>
<hr>

<a name="line1"></a><pre class="php" style="font-family:monospace;"><span style="color: #000000; font-weight: bold;">&lt;?php</span>
<a name="line2"></a>&nbsp;
<a name="line3"></a><span style="color: #009933; font-style: italic;">/** &lt;p&gt;Relating to API authentication and access limits, can occur with all API classes.&lt;/p&gt;
<a name="line4"></a> * 
<a name="line5"></a> * &lt;table&gt;
<a name="line6"></a> *   &lt;tr&gt;&lt;th&gt;Code&lt;/th&gt;&lt;th&gt;Message&lt;/th&gt;&lt;th&gt;Occurs when&lt;/th&gt;&lt;/tr&gt;
<a name="line7"></a> *   &lt;tr&gt;&lt;td&gt;100&lt;/td&gt;&lt;td&gt;key invalid&lt;/td&gt;&lt;td&gt;Accessing the API with a key that is not valid i.e. does not exist or has been deleted.&lt;/td&gt;&lt;/tr&gt;
<a name="line8"></a> *   &lt;tr&gt;&lt;td&gt;101&lt;/td&gt;&lt;td&gt;key suspended&lt;/td&gt;&lt;td&gt;Accessing the API with a key that has been suspended.&lt;/td&gt;&lt;/tr&gt;
<a name="line9"></a> *   &lt;tr&gt;&lt;td&gt;102&lt;/td&gt;&lt;td&gt;key not allowed access to specified resource&lt;/td&gt;&lt;td&gt;Accessing an API method with a key that is not allowed to perform the requested action.&lt;/td&gt;&lt;/tr&gt;
<a name="line10"></a> *   &lt;tr&gt;&lt;td&gt;103&lt;/td&gt;&lt;td&gt;request limit reached&lt;/td&gt;&lt;td&gt;Client IP has reached the request limit.&lt;/td&gt;&lt;/tr&gt;
<a name="line11"></a> *   &lt;tr&gt;&lt;td&gt;104&lt;/td&gt;&lt;td&gt;invalid email address or password&lt;/td&gt;&lt;td&gt;Requesting a key using invalid account credentials.&lt;/td&gt;&lt;/tr&gt;
<a name="line12"></a> *   &lt;tr&gt;&lt;td&gt;99&lt;/td&gt;&lt;td&gt;An unexpected APi access error occurred&lt;/td&gt;&lt;td&gt;&lt;/td&gt;&lt;/tr&gt;
<a name="line13"></a> * &lt;/table&gt;
<a name="line14"></a> *
<a name="line15"></a> * @package com\hostingreborn\api
<a name="line16"></a> *
<a name="line17"></a> * @author      Jon Cram &lt;jon@hostingreborn.com&gt;
<a name="line18"></a> * @copyright   https://api.hostingreborn.com/code/copyright/
<a name="line19"></a> * @license     https://api.hostingreborn.com/code/license/
<a name="line20"></a> * @version     1.0
<a name="line21"></a> *
<a name="line22"></a> *
<a name="line23"></a> */</span>
<a name="line24"></a><span style="color: #000000; font-weight: bold;">class</span> HR_apiAccessException <span style="color: #000000; font-weight: bold;">extends</span> Exception <span style="color: #009900;">&#123;</span>
<a name="line25"></a>&nbsp;
<a name="line26"></a><span style="color: #009900;">&#125;</span><span style="color: #339933;">;</span>
<a name="line27"></a>&nbsp;
<a name="line28"></a>&nbsp;
<a name="line29"></a><span style="color: #009933; font-style: italic;">/** &lt;p&gt;Relating to internal system errors, can occur with all API classes.&lt;/p&gt;
<a name="line30"></a> * 
<a name="line31"></a> * &lt;table&gt;
<a name="line32"></a> *   &lt;tr&gt;&lt;th&gt;Code&lt;/th&gt;&lt;th&gt;Message&lt;/th&gt;&lt;th&gt;Occurs when&lt;/th&gt;&lt;/tr&gt;
<a name="line33"></a> *   &lt;tr&gt;&lt;td&gt;100&lt;/td&gt;&lt;td&gt;System exception: unknown system error&lt;/td&gt;&lt;td&gt;One or more systems on which the API depends failed in a non-recoverable way (something crashed).&lt;/td&gt;&lt;/tr&gt;
<a name="line34"></a> * &lt;/table&gt;
<a name="line35"></a> *
<a name="line36"></a> * @package com\hostingreborn\api
<a name="line37"></a> *
<a name="line38"></a> * @author      Jon Cram &lt;jon@hostingreborn.com&gt;
<a name="line39"></a> * @copyright   https://api.hostingreborn.com/code/copyright/
<a name="line40"></a> * @license     https://api.hostingreborn.com/code/license/
<a name="line41"></a> * @version     1.0
<a name="line42"></a> *
<a name="line43"></a> *
<a name="line44"></a> */</span>
<a name="line45"></a><span style="color: #000000; font-weight: bold;">class</span> HR_apiBackendSystemException <span style="color: #000000; font-weight: bold;">extends</span> Exception <span style="color: #009900;">&#123;</span>
<a name="line46"></a>&nbsp;
<a name="line47"></a><span style="color: #009900;">&#125;</span><span style="color: #339933;">;</span>
<a name="line48"></a>&nbsp;
<a name="line49"></a>&nbsp;
<a name="line50"></a><span style="color: #009933; font-style: italic;">/** &lt;p&gt;When a request results in one or more database errors within the API, can occur with all API classes.&lt;/p&gt;
<a name="line51"></a> *
<a name="line52"></a> *
<a name="line53"></a> * @package com\hostingreborn\api
<a name="line54"></a> *
<a name="line55"></a> * @author      Jon Cram &lt;jon@hostingreborn.com&gt;
<a name="line56"></a> * @copyright   https://api.hostingreborn.com/code/copyright/
<a name="line57"></a> * @license     https://api.hostingreborn.com/code/license/
<a name="line58"></a> * @version     1.0
<a name="line59"></a> *
<a name="line60"></a> *
<a name="line61"></a> */</span>
<a name="line62"></a><span style="color: #000000; font-weight: bold;">class</span> HR_apiDatabaseException <span style="color: #000000; font-weight: bold;">extends</span> Exception <span style="color: #009900;">&#123;</span>
<a name="line63"></a>&nbsp;
<a name="line64"></a><span style="color: #009900;">&#125;</span><span style="color: #339933;">;</span>
<a name="line65"></a>&nbsp;
<a name="line66"></a><span style="color: #009933; font-style: italic;">/** &lt;p&gt;Relating to issues with an account, occurs with &lt;a href=&quot;hr_accountapi.html&quot;&gt;HR_accountApi&lt;/a&gt;, &lt;a href=&quot;hr_hostingaccountapi.html&quot;&gt;HR_hostingaccountApi&lt;/a&gt;.&lt;/p&gt;
<a name="line67"></a> *
<a name="line68"></a> * &lt;table&gt;
<a name="line69"></a> *   &lt;tr&gt;&lt;th&gt;Code&lt;/th&gt;&lt;th&gt;Message&lt;/th&gt;&lt;th&gt;Occurs when&lt;/th&gt;&lt;/tr&gt;
<a name="line70"></a> *   &lt;tr&gt;&lt;td&gt;101&lt;/td&gt;&lt;td&gt;action disallowed - account overdrawn&lt;/td&gt;&lt;td&gt;Performing an action that requires your account to be in credit, such as adding a new hosting account&lt;/td&gt;&lt;/tr&gt;
<a name="line71"></a> *   &lt;tr&gt;&lt;td&gt;200&lt;/td&gt;&lt;td&gt;password reset failed&lt;/td&gt;&lt;td&gt;&lt;/td&gt;&lt;/tr&gt;
<a name="line72"></a> *   &lt;tr&gt;&lt;td&gt;201&lt;/td&gt;&lt;td&gt;new email address already taken&lt;/td&gt;&lt;td&gt;Changing your account email address to one that is taken by another account&lt;/td&gt;&lt;/tr&gt;
<a name="line73"></a> *   &lt;tr&gt;&lt;td&gt;99&lt;/td&gt;&lt;td&gt;An unexpected account error occurred&lt;/td&gt;&lt;td&gt;&lt;/td&gt;&lt;/tr&gt;
<a name="line74"></a> * &lt;/table&gt;
<a name="line75"></a> *
<a name="line76"></a> * @package com\hostingreborn\api
<a name="line77"></a> *
<a name="line78"></a> * @author      Jon Cram &lt;jon@hostingreborn.com&gt;
<a name="line79"></a> * @copyright   https://api.hostingreborn.com/code/copyright/
<a name="line80"></a> * @license     https://api.hostingreborn.com/code/license/
<a name="line81"></a> * @version     1.0
<a name="line82"></a> *
<a name="line83"></a> *
<a name="line84"></a> */</span>
<a name="line85"></a><span style="color: #000000; font-weight: bold;">class</span> HR_apiAccountException <span style="color: #000000; font-weight: bold;">extends</span> Exception <span style="color: #009900;">&#123;</span>
<a name="line86"></a>&nbsp;
<a name="line87"></a><span style="color: #009900;">&#125;</span><span style="color: #339933;">;</span>
<a name="line88"></a>&nbsp;
<a name="line89"></a>&nbsp;
<a name="line90"></a><span style="color: #009933; font-style: italic;">/** &lt;p&gt;When the response from the API cannot be used, can occur with all API classes.&lt;/p&gt;
<a name="line91"></a> * 
<a name="line92"></a> * &lt;table&gt;
<a name="line93"></a> *   &lt;tr&gt;&lt;th&gt;Code&lt;/th&gt;&lt;th&gt;Message&lt;/th&gt;&lt;th&gt;Occurs when&lt;/th&gt;&lt;/tr&gt;
<a name="line94"></a> *   &lt;tr&gt;&lt;td&gt;100&lt;/td&gt;&lt;td&gt;no response from &amp;lt;url&amp;gt;&lt;/td&gt;&lt;td&gt;The API does not respond to all to a request.&lt;/td&gt;&lt;/tr&gt;
<a name="line95"></a> *   &lt;tr&gt;&lt;td&gt;101&lt;/td&gt;&lt;td&gt;API server returned malformed response&lt;/td&gt;&lt;td&gt;The API returns a response that cannot be understood.&lt;/td&gt;&lt;/tr&gt;
<a name="line96"></a> * &lt;/table&gt;
<a name="line97"></a> *
<a name="line98"></a> * @package com\hostingreborn\api
<a name="line99"></a> *
<a name="line100"></a> * @author      Jon Cram &lt;jon@hostingreborn.com&gt;
<a name="line101"></a> * @copyright   https://api.hostingreborn.com/code/copyright/
<a name="line102"></a> * @license     https://api.hostingreborn.com/code/license/
<a name="line103"></a> * @version     1.0
<a name="line104"></a> *
<a name="line105"></a> *
<a name="line106"></a> */</span>
<a name="line107"></a><span style="color: #000000; font-weight: bold;">class</span> HR_apiResponseException <span style="color: #000000; font-weight: bold;">extends</span> Exception <span style="color: #009900;">&#123;</span>
<a name="line108"></a>    <span style="color: #000000; font-weight: bold;">private</span> <span style="color: #000088;">$responseText</span><span style="color: #339933;">;</span>
<a name="line109"></a>&nbsp;
<a name="line110"></a>    <span style="color: #009933; font-style: italic;">/**
<a name="line111"></a>     *
<a name="line112"></a>     * @param string $message
<a name="line113"></a>     * @param int $code
<a name="line114"></a>     * @param string $responseText
<a name="line115"></a>     */</span>
<a name="line116"></a>    <span style="color: #000000; font-weight: bold;">public</span> <span style="color: #000000; font-weight: bold;">function</span> __construct<span style="color: #009900;">&#40;</span><span style="color: #000088;">$message</span> <span style="color: #339933;">=</span> <span style="color: #0000ff;">''</span><span style="color: #339933;">,</span> <span style="color: #000088;">$code</span> <span style="color: #339933;">=</span> <span style="color: #cc66cc;">0</span><span style="color: #339933;">,</span> <span style="color: #000088;">$responseText</span> <span style="color: #339933;">=</span> <span style="color: #0000ff;">''</span><span style="color: #009900;">&#41;</span> <span style="color: #009900;">&#123;</span>
<a name="line117"></a>        parent<span style="color: #339933;">::</span>__construct<span style="color: #009900;">&#40;</span><span style="color: #000088;">$message</span><span style="color: #339933;">,</span> <span style="color: #000088;">$code</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
<a name="line118"></a>        <span style="color: #000088;">$this</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">responseText</span> <span style="color: #339933;">=</span> <span style="color: #000088;">$responseText</span><span style="color: #339933;">;</span>
<a name="line119"></a>    <span style="color: #009900;">&#125;</span>
<a name="line120"></a>&nbsp;
<a name="line121"></a><span style="color: #009900;">&#125;</span><span style="color: #339933;">;</span>
<a name="line122"></a>&nbsp;
<a name="line123"></a><span style="color: #009933; font-style: italic;">/** &lt;p&gt;Relating to issues with a hosting account, occurs with &lt;a href=&quot;hr_hostingaccountapi.html&quot;&gt;HR_hostingaccountApi&lt;/a&gt;.&lt;/p&gt;
<a name="line124"></a> *
<a name="line125"></a> * &lt;table&gt;
<a name="line126"></a> *   &lt;tr&gt;&lt;th&gt;Code&lt;/th&gt;&lt;th&gt;Message&lt;/th&gt;&lt;th&gt;Occurs when&lt;/th&gt;&lt;/tr&gt;
<a name="line127"></a> *   &lt;tr&gt;&lt;td&gt;100&lt;/td&gt;&lt;td&gt;User name invalid&lt;/td&gt;&lt;td&gt;Providing an invalid user name when creating a new hosting account&lt;/td&gt;&lt;/tr&gt;
<a name="line128"></a> *   &lt;tr&gt;&lt;td&gt;101&lt;/td&gt;&lt;td&gt;Domain name invalid&lt;/td&gt;&lt;td&gt;Providing an invalid domain name when creating a new hosting account&lt;/td&gt;&lt;/tr&gt;
<a name="line129"></a> *   &lt;tr&gt;&lt;td&gt;102&lt;/td&gt;&lt;td&gt;Domain name taken&lt;/td&gt;&lt;td&gt;Providing a domain name already used by another hosting account when creating a new hosting account&lt;/td&gt;&lt;/tr&gt;
<a name="line130"></a> *   &lt;tr&gt;&lt;td&gt;103&lt;/td&gt;&lt;td&gt;User name taken&lt;/td&gt;&lt;td&gt;Proving a username already taken by another hosting account when creating a new hosting account&lt;/td&gt;&lt;/tr&gt;
<a name="line131"></a> *   &lt;tr&gt;&lt;td&gt;104&lt;/td&gt;&lt;td&gt;No working servers found&lt;/td&gt;&lt;td&gt;No working hosting servers could be found when creating a new hosting account&lt;/td&gt;&lt;/tr&gt;
<a name="line132"></a> *   &lt;tr&gt;&lt;td&gt;105&lt;/td&gt;&lt;td&gt;All servers have reached their storage limits&lt;/td&gt;&lt;td&gt;No hosting servers with free space could be found when creating a new hosting account&lt;/td&gt;&lt;/tr&gt;
<a name="line133"></a> *   &lt;tr&gt;&lt;td&gt;200&lt;/td&gt;&lt;td&gt;password reset failed&lt;/td&gt;&lt;td&gt;&lt;/td&gt;&lt;/tr&gt;
<a name="line134"></a> *   &lt;tr&gt;&lt;td&gt;201&lt;/td&gt;&lt;td&gt;action failed as hosting account is suspended&lt;/td&gt;&lt;td&gt;&lt;/td&gt;&lt;/tr&gt;
<a name="line135"></a> *   &lt;tr&gt;&lt;td&gt;99&lt;/td&gt;&lt;td&gt;Unknown error&lt;/td&gt;&lt;td&gt;&lt;/td&gt;&lt;/tr&gt;
<a name="line136"></a> * &lt;/table&gt;
<a name="line137"></a> *
<a name="line138"></a> * @package com\hostingreborn\api
<a name="line139"></a> *
<a name="line140"></a> * @author      Jon Cram &lt;jon@hostingreborn.com&gt;
<a name="line141"></a> * @copyright   https://api.hostingreborn.com/code/copyright/
<a name="line142"></a> * @license     https://api.hostingreborn.com/code/license/
<a name="line143"></a> * @version     1.0
<a name="line144"></a> *
<a name="line145"></a> *
<a name="line146"></a> */</span>
<a name="line147"></a><span style="color: #000000; font-weight: bold;">class</span> HR_apiHostingAccountException <span style="color: #000000; font-weight: bold;">extends</span> Exception <span style="color: #009900;">&#123;</span>
<a name="line148"></a>&nbsp;
<a name="line149"></a><span style="color: #009900;">&#125;</span><span style="color: #339933;">;</span>
<a name="line150"></a>&nbsp;
<a name="line151"></a>&nbsp;
<a name="line152"></a><span style="color: #009933; font-style: italic;">/** &lt;p&gt;For errors not handled directly by the core API class, &lt;i&gt;must&lt;/i&gt; be handled by any class extending the core API.&lt;/p&gt;
<a name="line153"></a> *
<a name="line154"></a> * @package com\hostingreborn\api
<a name="line155"></a> *
<a name="line156"></a> * @author      Jon Cram &lt;jon@hostingreborn.com&gt;
<a name="line157"></a> * @copyright   https://api.hostingreborn.com/code/copyright/
<a name="line158"></a> * @license     https://api.hostingreborn.com/code/license/
<a name="line159"></a> * @version     1.0
<a name="line160"></a> *
<a name="line161"></a> *
<a name="line162"></a> */</span>
<a name="line163"></a><span style="color: #000000; font-weight: bold;">class</span> HR_apiResponseUnhandledException <span style="color: #000000; font-weight: bold;">extends</span> Exception <span style="color: #009900;">&#123;</span>
<a name="line164"></a>&nbsp;
<a name="line165"></a>    <span style="color: #009933; font-style: italic;">/**
<a name="line166"></a>     *
<a name="line167"></a>     * @var string $apiExceptionType
<a name="line168"></a>     */</span>
<a name="line169"></a>    <span style="color: #000000; font-weight: bold;">private</span> <span style="color: #000088;">$apiExceptionType</span><span style="color: #339933;">;</span>
<a name="line170"></a>&nbsp;
<a name="line171"></a>&nbsp;
<a name="line172"></a>    <span style="color: #009933; font-style: italic;">/**
<a name="line173"></a>     *
<a name="line174"></a>     * @var string $apiExceptionMessage
<a name="line175"></a>     */</span>
<a name="line176"></a>    <span style="color: #000000; font-weight: bold;">private</span> <span style="color: #000088;">$apiExceptionMessage</span><span style="color: #339933;">;</span>
<a name="line177"></a>&nbsp;
<a name="line178"></a>&nbsp;
<a name="line179"></a>    <span style="color: #009933; font-style: italic;">/**
<a name="line180"></a>     *
<a name="line181"></a>     * @var int $apiExceptionCode
<a name="line182"></a>     */</span>
<a name="line183"></a>    <span style="color: #000000; font-weight: bold;">private</span> <span style="color: #000088;">$apiExceptionCode</span><span style="color: #339933;">;</span>
<a name="line184"></a>&nbsp;
<a name="line185"></a>&nbsp;
<a name="line186"></a>    <span style="color: #009933; font-style: italic;">/**
<a name="line187"></a>     *
<a name="line188"></a>     * @param string $message Exception message, passed to Exception::__construct()
<a name="line189"></a>     */</span>
<a name="line190"></a>    <span style="color: #000000; font-weight: bold;">public</span> <span style="color: #000000; font-weight: bold;">function</span> __construct<span style="color: #009900;">&#40;</span><span style="color: #000088;">$message</span><span style="color: #009900;">&#41;</span> <span style="color: #009900;">&#123;</span>
<a name="line191"></a>        parent<span style="color: #339933;">::</span>__construct<span style="color: #009900;">&#40;</span><span style="color: #000088;">$message</span><span style="color: #009900;">&#41;</span><span style="color: #339933;">;</span>
<a name="line192"></a>    <span style="color: #009900;">&#125;</span>
<a name="line193"></a>&nbsp;
<a name="line194"></a>&nbsp;
<a name="line195"></a>    <span style="color: #009933; font-style: italic;">/**
<a name="line196"></a>     *
<a name="line197"></a>     * @param string $type
<a name="line198"></a>     * @param string $message
<a name="line199"></a>     * @param string $code
<a name="line200"></a>     */</span>
<a name="line201"></a>    <span style="color: #000000; font-weight: bold;">public</span> <span style="color: #000000; font-weight: bold;">function</span> setApiExceptionDetails<span style="color: #009900;">&#40;</span><span style="color: #000088;">$type</span><span style="color: #339933;">,</span> <span style="color: #000088;">$message</span><span style="color: #339933;">,</span> <span style="color: #000088;">$code</span><span style="color: #009900;">&#41;</span> <span style="color: #009900;">&#123;</span>
<a name="line202"></a>        <span style="color: #000088;">$this</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">apiExceptionType</span> <span style="color: #339933;">=</span> <span style="color: #000088;">$type</span><span style="color: #339933;">;</span>
<a name="line203"></a>        <span style="color: #000088;">$this</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">apiExceptionMessage</span> <span style="color: #339933;">=</span> <span style="color: #000088;">$message</span><span style="color: #339933;">;</span>
<a name="line204"></a>        <span style="color: #000088;">$this</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">apiExceptionCode</span> <span style="color: #339933;">=</span> <span style="color: #000088;">$code</span><span style="color: #339933;">;</span>
<a name="line205"></a>    <span style="color: #009900;">&#125;</span>
<a name="line206"></a>&nbsp;
<a name="line207"></a>&nbsp;
<a name="line208"></a>    <span style="color: #009933; font-style: italic;">/**
<a name="line209"></a>     *
<a name="line210"></a>     * @return string
<a name="line211"></a>     */</span>
<a name="line212"></a>    <span style="color: #000000; font-weight: bold;">public</span> <span style="color: #000000; font-weight: bold;">function</span> getApiExceptionType<span style="color: #009900;">&#40;</span><span style="color: #009900;">&#41;</span> <span style="color: #009900;">&#123;</span>
<a name="line213"></a>        <span style="color: #b1b100;">return</span> <span style="color: #000088;">$this</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">apiExceptionType</span><span style="color: #339933;">;</span>
<a name="line214"></a>    <span style="color: #009900;">&#125;</span>
<a name="line215"></a>&nbsp;
<a name="line216"></a>&nbsp;
<a name="line217"></a>    <span style="color: #009933; font-style: italic;">/**
<a name="line218"></a>     *
<a name="line219"></a>     * @return string
<a name="line220"></a>     */</span>
<a name="line221"></a>    <span style="color: #000000; font-weight: bold;">public</span> <span style="color: #000000; font-weight: bold;">function</span> getApiExceptionMessage<span style="color: #009900;">&#40;</span><span style="color: #009900;">&#41;</span> <span style="color: #009900;">&#123;</span>
<a name="line222"></a>        <span style="color: #b1b100;">return</span> <span style="color: #000088;">$this</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">apiExceptionMessage</span><span style="color: #339933;">;</span>
<a name="line223"></a>    <span style="color: #009900;">&#125;</span>
<a name="line224"></a>&nbsp;
<a name="line225"></a>&nbsp;
<a name="line226"></a>    <span style="color: #009933; font-style: italic;">/**
<a name="line227"></a>     *
<a name="line228"></a>     * @return int
<a name="line229"></a>     */</span>
<a name="line230"></a>    <span style="color: #000000; font-weight: bold;">public</span> <span style="color: #000000; font-weight: bold;">function</span> getApiExceptionCode<span style="color: #009900;">&#40;</span><span style="color: #009900;">&#41;</span> <span style="color: #009900;">&#123;</span>
<a name="line231"></a>        <span style="color: #b1b100;">return</span> <span style="color: #000088;">$this</span><span style="color: #339933;">-&gt;</span><span style="color: #004000;">apiExceptionCode</span><span style="color: #339933;">;</span>
<a name="line232"></a>    <span style="color: #009900;">&#125;</span>
<a name="line233"></a>&nbsp;
<a name="line234"></a><span style="color: #009900;">&#125;</span><span style="color: #339933;">;</span>
<a name="line235"></a>&nbsp;
<a name="line236"></a>&nbsp;
<a name="line237"></a><span style="color: #009933; font-style: italic;">/** &lt;p&gt;Relating to issues with servers, occurs with &lt;a href=&quot;hr_serverapi.html&quot;&gt;HR_serverApi&lt;/a&gt;.&lt;/p&gt;
<a name="line238"></a> *
<a name="line239"></a> * &lt;table&gt;
<a name="line240"></a> *   &lt;tr&gt;&lt;th&gt;Code&lt;/th&gt;&lt;th&gt;Message&lt;/th&gt;&lt;th&gt;Occurs when&lt;/th&gt;&lt;/tr&gt;
<a name="line241"></a> *   &lt;tr&gt;&lt;td&gt;310&lt;/td&gt;&lt;td&gt;not found&lt;/td&gt;&lt;td&gt;Requesting details of a server that does not existe&lt;/td&gt;&lt;/tr&gt;
<a name="line242"></a> *   &lt;tr&gt;&lt;td&gt;99&lt;/td&gt;&lt;td&gt;Unknown error&lt;/td&gt;&lt;td&gt;&lt;/td&gt;&lt;/tr&gt;
<a name="line243"></a> * &lt;/table&gt;
<a name="line244"></a> *
<a name="line245"></a> * @package com\hostingreborn\api
<a name="line246"></a> *
<a name="line247"></a> * @author      Jon Cram &lt;jon@hostingreborn.com&gt;
<a name="line248"></a> * @copyright   https://api.hostingreborn.com/code/copyright/
<a name="line249"></a> * @license     https://api.hostingreborn.com/code/license/
<a name="line250"></a> * @version     1.0
<a name="line251"></a> *
<a name="line252"></a> *
<a name="line253"></a> */</span>
<a name="line254"></a><span style="color: #000000; font-weight: bold;">class</span> HR_apiServerException <span style="color: #000000; font-weight: bold;">extends</span> Exception <span style="color: #009900;">&#123;</span>
<a name="line255"></a>&nbsp;
<a name="line256"></a><span style="color: #009900;">&#125;</span><span style="color: #339933;">;</span>
<a name="line257"></a>&nbsp;
<a name="line258"></a><span style="color: #000000; font-weight: bold;">?&gt;</span></pre>
<div class="header">
<h1>Hosting Reborn API PHP Library</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li>Package</li><li>Class</li><li>Tree</li><li><a href="../overview-files.html">Files</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../index.html" target="_top">Frames</a>
<a href="../source/hr_apiexceptions.php.html" target="_top">No frames</a>
</div>
<hr>

<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>

</body>

</html>